Contents

• Helm cheat sheet
  • Charts
    • Add a chart to repository
    • List charts in repository
    • Deploy a chart from the repository
    • Get chart data
    • Upgrade a helm chart
  • Deployments
    • List deployments within a namespace
  • Deleting a deployment
  • Debugging
  • Rendering a template

Helm cheat sheet

A sheet of useful command line functions for Helm.

Charts

Add a chart to repository

$ helm repo add <name> <chart_path>
$ helm repo update

List charts in repository

$ helm repo list                                 

Deploy a chart from the repository

$ sudo helm install <deployment_name> <chart_name> -f <config_yaml_file> -n <namespace>

• --dry-run can be used to simulate the install.
• --debug can be used to retrieve more verbose output.

Get chart data

$ helm get all <chart_name> -n <namespace>

Upgrade a helm chart

$ sudo helm upgrade <deployment_name> <chart_name> -f <config_yaml_file> -n <namespace>

• --dry-run can be used to simulate the install.
• --debug can be used to retrieve more verbose output.

If the operation times out with Error: timed out waiting for the condition, add the --timeout flag with some arbitrarily large number (seconds).

Note that consecutive failed upgrades can put the deployment in to a state where the upgrade command does not recognise that the deployment exists. At this point, you will need to delete the deployment and start again.

Deployments

List deployments within a namespace

$ helm list -n <namespace>

returns e.g.

NAME    NAMESPACE   REVISION    UPDATED                                 STATUS      CHART               APP VERSION
xx      xx          11          2020-06-08 17:10:08.321407561 +0000 UTC deployed    xx-0.9.0            1.1.0  

• -A can be used to list deployments in ALL namespaces.

Deleting a deployment

$ sudo helm delete <deployment_name> -n <namespace>

Debugging

Rendering a template

Renders templates using a values.yaml.

$ sudo helm template .